Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Decrease ping timeout to 2s #44541

Closed
wants to merge 1 commit into from
Closed

Conversation

iwiznia
Copy link
Contributor

@iwiznia iwiznia commented Jun 27, 2024

Details

See https://expensify.slack.com/archives/C03TQ48KC/p1719482824987529
#44269

Tests

None, it seems we don't call Ping in dev, not sure why.

QA Steps

No

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@iwiznia iwiznia self-assigned this Jun 27, 2024
@iwiznia iwiznia requested a review from a team as a code owner June 27, 2024 12:17
@melvin-bot melvin-bot bot requested review from grgia and removed request for a team June 27, 2024 12:17
Copy link

melvin-bot bot commented Jun 27, 2024

@grgia Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@srikarparsi srikarparsi self-requested a review June 27, 2024 16:30
@srikarparsi
Copy link
Contributor

Also looking into this here. I'm going to look at this again towards the end of the day and will try to check as well if reducing the timeout fixes this. This was tested here so I'll just try copying the testing steps.

@iwiznia
Copy link
Contributor Author

iwiznia commented Jun 27, 2024

Ah nice, did not know that existed. I think this should fix that issue, no?

@srikarparsi
Copy link
Contributor

srikarparsi commented Jun 27, 2024

I'm not really sure if it's the best way because the defaults have reachabilityRequestTimeout to default to 15s so decreasing to 2s might not be recommended. And reachabilityShortTimeout is also defaulted to 5s which is shorter than 15s.

I'm thinking something like this instead but still have to test and everything. Basically preventing another network check if one is running.

@iwiznia
Copy link
Contributor Author

iwiznia commented Jun 28, 2024

I'm not really sure if it's the best way because the defaults have reachabilityRequestTimeout to default to 15s so decreasing to 2s might not be recommended

Huh? I am changing it from 10 to 2, 15 is not used.

And reachabilityShortTimeout is also defaulted to 5s which is shorter than 15s.

15 is not used and yes 5 is lower than 15, so what?

Not sure what your concern is exactly with the change.

I'm thinking something like #44565 instead but still have to test and everything. Basically preventing another network check if one is running.

I think they are complimentary changes.

@srikarparsi
Copy link
Contributor

Sorry, I'm not sure if it matters but this is what I was trying to say.

The reasoning behind this PR is that we check for connection every 5s but each check takes 10s to timeout. So network requests are piling up when there is slow internet connection.

But I'm saying that the default value for the check to timeout is 15s (we changed this to 10s). And if their default value for the request timeout is greater than the time between checking connections, then maybe this is fine and their code already accounts it?

I'm also not too sure what this change would do once this PR is merged. Currently, I only see the downside of showing "You appear to be offline" when Ping takes 3s to respond on super slow connection (even though the user is connected to internet).

But I'm not too sure because I haven't looked at their code. Maybe we could try 5 seconds first and see what happens and reduce to 2? I can also merge as is if you think it's worth it to try.

@iwiznia
Copy link
Contributor Author

iwiznia commented Jun 28, 2024

But I'm saying that the default value for the check to timeout is 15s (we changed this to 10s). And if their default value for the request timeout is greater than the time between checking connections, then maybe this is fine and their code already accounts it?

How? Where? I am looking at the behavior in the network tab and it does not seem like it.

I'm also not too sure what this change would do once this #44565 is merged. Currently, I only see the downside of showing "You appear to be offline" when Ping takes 3s to respond on super slow connection (even though the user is connected to internet).

I don't think this is a downside really, your internet is so slow that something that normally takes a few ms is taking several seconds

But I'm not too sure because I haven't looked at their code. Maybe we could try 5 seconds first and see what happens and reduce to 2? I can also merge as is if you think it's worth it to try.

If you want, we can try 5s... I am also fine on holding this and deploying your other PR first

@srikarparsi
Copy link
Contributor

srikarparsi commented Jun 28, 2024

How? Where? I am looking at the behavior in the network tab and it does not seem like it.

Yeah, you're right. I just felt like they wouldn't recommend those values as the default without properly testing it and maybe somewhere else in our implementation is wrong but who knows.

I don't think this is a downside really, your internet is so slow that something that normally takes a few ms is taking several seconds

Yeah, maybe, I'm not too sure. On other applications, it generally shows "Your network connection seems to be slow" vs "You appear to be offline" since it's still making network request. I'm not really sure.

If you want, we can try 5s... I am also fine on holding this and deploying your other PR first

Sounds good, I think we can merge the other PR today and test Monday/Tuesday

@srikarparsi
Copy link
Contributor

Hey @iwiznia, I think we can close out this PR? This was fixed here

@iwiznia
Copy link
Contributor Author

iwiznia commented Aug 9, 2024

oh ok, wish we had merged this back then.

@iwiznia iwiznia closed this Aug 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants